


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta content="reStructuredText, demonstration, demo, parser" name="keywords" />
<meta content="A demonstration of the reStructuredText markup language, containing examples of all basic constructs and many advanced constructs." lang="en" name="description" xml:lang="en" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>3. Paragraph Level Markup &mdash; Torch-TensorRT v1.3.0 documentation</title>















  <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
  <!-- <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> -->
  <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../../_static/collapsible-lists/css/tree_view.css" type="text/css" />
    <link rel="index" title="Index" href="../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../search.html" />
  <!-- Google Analytics -->

  <!-- End Google Analytics -->



  <script src="../../../../_static/js/modernizr.min.js"></script>

  <!-- Preload the theme fonts -->

<link rel="preload" href="../../../../_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../../../../_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../../../../_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../../../../_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../../../../_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../../../../_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<!-- Preload the katex fonts -->

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.2/css/all.css" integrity="sha384-vSIIfh2YWi9wW0r9iZe7RJPrKwp6bG+s9QZMoITbCckVJqGCCRhc+ccxNcdpHuYu" crossorigin="anonymous">
</head>

<div class="container-fluid header-holder tutorials-header" id="header-holder">
  <div class="container">
    <div class="header-container">
      <a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>

      <div class="main-menu">
        <ul>
          <li>
            <a href="https://pytorch.org/get-started">Get Started</a>
          </li>

          <li>
            <a href="https://pytorch.org/ecosystem">Ecosystem</a>
          </li>

          <li>
            <a href="https://pytorch.org/mobile">Mobile</a>
          </li>

          <li>
            <a href="https://pytorch.org/blog/">Blog</a>
          </li>

          <li>
            <a href="https://pytorch.org/tutorials">Tutorials</a>
          </li>

          <li>
            <div id="resourcesDropdownButton" data-toggle="resources-dropdown" class="resources-dropdown">
              <a class="resource-option with-down-orange-arrow">
                Docs
              </a>
              <div class="resources-dropdown-menu">
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/docs/stable/index.html">
                  <span class="dropdown-title">PyTorch</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/audio/stable/index.html">
                  <span class="dropdown-title">torchaudio</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/text/stable/index.html">
                  <span class="dropdown-title">torchtext</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/vision/stable/index.html">
                  <span class="dropdown-title">torchvision</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torcharrow">
                  <span class="dropdown-title">torcharrow</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/data">
                  <span class="dropdown-title">TorchData</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torchrec">
                  <span class="dropdown-title">TorchRec</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/serve/">
                  <span class="dropdown-title">TorchServe</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torchx/">
                  <span class="dropdown-title">TorchX</span>
                  <p></p>
                </a>
                <a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/xla">
                  <span class="dropdown-title">PyTorch on XLA Devices</span>
                  <p></p>
                </a>
            </div>
          </li>

          <li>
            <div id="resourcesDropdownButton" data-toggle="resources-dropdown" class="resources-dropdown">
              <a class="resource-option with-down-arrow">
                Resources
              </a>
              <div class="resources-dropdown-menu">
                <a class="nav-dropdown-item" href="https://pytorch.org/features">
                  <span class="dropdown-title">About</span>
                  <p>Learn about PyTorch’s features and capabilities</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/foundation">
                  <span class="dropdown-title">PyTorch Foundation</span>
                  <p>Learn about the PyTorch foundation</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/#community-module">
                  <span class="dropdown-title">Community</span>
                  <p>Join the PyTorch developer community to contribute, learn, and get your questions answered.</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/community-stories">
                  <span class="dropdown-title">Community Stories</span>
                  <p>Learn how our community solves real, everyday machine learning problems with PyTorch.</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/resources">
                  <span class="dropdown-title">Developer Resources</span>
                  <p>Find resources and get questions answered</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/events">
                  <span class="dropdown-title">Events</span>
                  <p>Find events, webinars, and podcasts</p>
                </a>
                <a class="nav-dropdown-item" href="https://discuss.pytorch.org/" target="_blank">
                  <span class="dropdown-title">Forums</span>
                  <p>A place to discuss PyTorch code, issues, install, research</p>
                </a>
                <a class="nav-dropdown-item" href="https://pytorch.org/hub">
                  <span class="dropdown-title">Models (Beta)</span>
                  <p>Discover, publish, and reuse pre-trained models</p>
                </a>
              </div>
            </div>
          </li>

          <li>
            <a href="https://github.com/pytorch/pytorch">GitHub</a>
          </li>
        </ul>
      </div>

      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
    </div>
  </div>
</div>

<body class="pytorch-body">





    <div class="table-of-contents-link-wrapper">
      <span>Table of Contents</span>
      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
    </div>

    <nav data-toggle="wy-nav-shift" class="pytorch-left-menu" id="pytorch-left-menu">
      <div class="pytorch-side-scroll">
        <div class="pytorch-menu pytorch-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          <div class="pytorch-left-menu-search">





                <div class="version">
                  v1.3.0
                </div>









<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search Docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>


          </div>







              <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/getting_started_with_python_api.html">Using Torch-TensorRT in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/getting_started_with_cpp_api.html">Using Torch-TensorRT in  C++</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/creating_torchscript_module_in_python.html">Creating a TorchScript Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/creating_torchscript_module_in_python.html#working-with-torchscript-in-python">Working with TorchScript in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/creating_torchscript_module_in_python.html#saving-torchscript-module-to-disk">Saving TorchScript Module to Disk</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/getting_started_with_fx_path.html">Torch-TensorRT (FX Frontend) User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/ptq.html">Post Training Quantization (PTQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/runtime.html">Deploying Torch-TensorRT Programs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/serving_torch_tensorrt_with_triton.html">Serving a Torch-TensorRT model with Triton</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/use_from_pytorch.html">Using Torch-TensorRT Directly From PyTorch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/using_dla.html">DLA</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/notebooks.html">Example notebooks</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Python API Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../py_api/torch_tensorrt.html">torch_tensorrt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../py_api/logging.html">torch_tensorrt.logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../py_api/ptq.html">torch_tensorrt.ptq</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../py_api/ts.html">torch_tensorrt.ts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../py_api/fx.html">torch_tensorrt.fx</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">C++ API Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../_cpp_api/torch_tensort_cpp.html">Torch-TensorRT C++ API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_cpp_api/namespace_torch_tensorrt.html">Namespace torch_tensorrt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_cpp_api/namespace_torch_tensorrt__logging.html">Namespace torch_tensorrt::logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_cpp_api/namespace_torch_tensorrt__torchscript.html">Namespace torch_tensorrt::torchscript</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_cpp_api/namespace_torch_tensorrt__ptq.html">Namespace torch_tensorrt::ptq</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">CLI Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli/torchtrtc.html">torchtrtc</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contributor Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../contributors/system_overview.html">System Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../contributors/writing_converters.html">Writing Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../contributors/useful_links.html">Useful Links for Torch-TensorRT Development</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Indices</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../indices/supported_ops.html">Operators Supported</a></li>
</ul>



        </div>
      </div>
    </nav>

    <div class="pytorch-container">
      <div class="pytorch-page-level-bar" id="pytorch-page-level-bar">
        <div class="pytorch-breadcrumbs-wrapper">
















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="pytorch-breadcrumbs">

      <li>
        <a href="../../../../index.html">

            Docs

        </a> &gt;
      </li>


      <li><span class="section-number">3. </span>Paragraph Level Markup</li>


      <li class="pytorch-breadcrumbs-aside">


            <a href="../../../../_sources/src/pytorch-sphinx-theme/docs/demo/demo.rst.txt" rel="nofollow"><img src="../../../../_static/images/view-page-source-icon.svg"></a>


      </li>

  </ul>


</div>
        </div>

        <div class="pytorch-shortcuts-wrapper" id="pytorch-shortcuts-wrapper">
          Shortcuts
        </div>
      </div>

      <section data-toggle="wy-nav-shift" id="pytorch-content-wrap" class="pytorch-content-wrap">
        <div class="pytorch-content-left">



          <div class="rst-content">

            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
             <article itemprop="articleBody" id="pytorch-article" class="pytorch-article">

  <section id="paragraph-level-markup">
<h1><a class="toc-backref" href="#id33"><span class="section-number">3. </span>Paragraph Level Markup</a><a class="headerlink" href="#paragraph-level-markup" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#paragraph-level-markup" id="id33">Paragraph Level Markup</a></p>
<ul>
<li><p><a class="reference internal" href="#inline-markup" id="id34">Inline Markup</a></p></li>
<li><p><a class="reference internal" href="#math" id="id35">Math</a></p></li>
<li><p><a class="reference internal" href="#meta" id="id36">Meta</a></p></li>
<li><p><a class="reference internal" href="#blocks" id="id37">Blocks</a></p>
<ul>
<li><p><a class="reference internal" href="#literal-blocks" id="id38">Literal Blocks</a></p></li>
<li><p><a class="reference internal" href="#line-blocks" id="id39">Line Blocks</a></p></li>
<li><p><a class="reference internal" href="#block-quotes" id="id40">Block Quotes</a></p></li>
<li><p><a class="reference internal" href="#doctest-blocks" id="id41">Doctest Blocks</a></p></li>
<li><p><a class="reference internal" href="#code-blocks" id="id42">Code Blocks</a></p>
<ul>
<li><p><a class="reference internal" href="#emphasized-lines-with-line-numbers" id="id43">Emphasized lines with line numbers</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#sidebar" id="id44">Sidebar</a></p>
<ul>
<li><p><a class="reference internal" href="#code-with-sidebar" id="id45">Code with Sidebar</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#references" id="id46">References</a></p>
<ul>
<li><p><a class="reference internal" href="#footnotes" id="id47">Footnotes</a></p></li>
<li><p><a class="reference internal" href="#citations" id="id48">Citations</a></p></li>
<li><p><a class="reference internal" href="#glossary" id="id49">Glossary</a></p></li>
<li><p><a class="reference internal" href="#targets" id="id50">Targets</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#directives" id="id51">Directives</a></p>
<ul>
<li><p><a class="reference internal" href="#contents" id="id52">Contents</a></p></li>
<li><p><a class="reference internal" href="#centered-text" id="id53">Centered text</a></p></li>
<li><p><a class="reference internal" href="#images-figures" id="id54">Images &amp; Figures</a></p>
<ul>
<li><p><a class="reference internal" href="#images" id="id55">Images</a></p></li>
<li><p><a class="reference internal" href="#figures" id="id56">Figures</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#admonitions" id="id57">Admonitions</a></p></li>
<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="id58">Topics, Sidebars, and Rubrics</a></p></li>
<li><p><a class="reference internal" href="#target-footnotes" id="id59">Target Footnotes</a></p></li>
<li><p><a class="reference internal" href="#replacement-text" id="id60">Replacement Text</a></p></li>
<li><p><a class="reference internal" href="#compound-paragraph" id="id61">Compound Paragraph</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#download-links" id="id62">Download Links</a></p></li>
</ul>
</li>
</ul>
</div>
<section id="inline-markup">
<h2><a class="toc-backref" href="#id34"><span class="section-number">3.1. </span>Inline Markup</a><a class="headerlink" href="#inline-markup" title="Permalink to this headline">¶</a></h2>
<p>Paragraphs contain text and may contain inline markup: <em>emphasis</em>, <strong>strong emphasis</strong>, <code class="docutils literal notranslate"><span class="pre">inline</span> <span class="pre">literals</span></code>,
standalone hyperlinks (<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#id29" id="id30">5</a>), internal cross-references (<a class="reference internal" href="#example">example</a>),
external hyperlinks with embedded URIs (<a class="reference external" href="http://www.python.org">Python web site</a>), footnote references
(manually numbered <a class="footnote-reference brackets" href="#id6" id="id1">1</a>, anonymous auto-numbered <a class="footnote-reference brackets" href="#id9" id="id2">3</a>, labeled auto-numbered <a class="footnote-reference brackets" href="#label" id="id3">2</a>, or symbolic <a class="footnote-reference brackets" href="#id10" id="id4">*</a>),
citation references (<a class="footnote-reference brackets" href="#id16" id="id5">12</a>), substitution references (<a class="reference internal" href="../../../../_images/yi_jing_01_chien.jpg"><img alt="EXAMPLE" src="../../../../_images/yi_jing_01_chien.jpg" style="width: 1em;" /></a>), and <span class="target" id="inline-hyperlink-targets">inline hyperlink targets</span>
(see <a class="reference internal" href="#targets">Targets</a> below for a reference back to here). Character-level inline markup is also possible
(although exceedingly ugly!) in <em>re</em><code class="docutils literal notranslate"><span class="pre">Structured</span></code><em>Text</em>. Problems are indicated by <a href="#id27"><span class="problematic" id="id28">|problematic|</span></a>
text (generated by processing errors; this one is intentional).</p>
<p>Also with <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc</span></code>, which I use in the demo, I can link to <code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">test_py_module.test.Foo</span></code>.
It will link you right my code documentation for it.</p>
<p>The default role for interpreted text is <cite>Title Reference</cite>.  Here are some explicit interpreted text roles:
a PEP reference (<span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0287/"><strong>PEP 287</strong></a>); an RFC reference (<span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2822.html"><strong>RFC 2822</strong></a>); a <sub>subscript</sub>; a <sup>superscript</sup>;
and explicit roles for <em>standard</em> <strong>inline</strong> <code class="docutils literal notranslate"><span class="pre">markup</span></code>.</p>
<p>GUI labels are a useful way to indicate that <span class="guilabel">Some action</span> is to be taken by the user.
The GUI label should not run over <code class="docutils literal notranslate"><span class="pre">line-height</span></code> so as not to <span class="guilabel">interfere</span> with text from adjacent lines.</p>
<p>Key-bindings indicate that the read is to press a button on the keyboard or mouse,
for example <kbd class="kbd docutils literal notranslate">MMB</kbd> and <kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Shift</kbd>-<kbd class="kbd docutils literal notranslate">MMB</kbd></kbd>. Another useful markup to indicate a user action
is to use <code class="docutils literal notranslate"><span class="pre">menuselection</span></code> this can be used to show short and long menus in software.
For example, and <code class="docutils literal notranslate"><span class="pre">menuselection</span></code> can be seen here that breaks is too long to fit on this line.
<span class="menuselection">My ‣ Software ‣ Some menu ‣ Some sub menu 1 ‣ sub menu 2</span>.</p>
<p>Let’s test wrapping and whitespace significance in inline literals:
<code class="docutils literal notranslate"><span class="pre">This</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">example</span> <span class="pre">of</span> <span class="pre">--inline-literal</span> <span class="pre">--text,</span> <span class="pre">--including</span> <span class="pre">some--</span>
<span class="pre">strangely--hyphenated-words.</span>&#160; <span class="pre">Adjust-the-width-of-your-browser-window</span>
<span class="pre">to</span> <span class="pre">see</span> <span class="pre">how</span> <span class="pre">the</span> <span class="pre">text</span> <span class="pre">is</span> <span class="pre">wrapped.</span>&#160; <span class="pre">--</span> <span class="pre">----</span> <span class="pre">--------</span>&#160; <span class="pre">Now</span> <span class="pre">note</span>&#160;&#160;&#160; <span class="pre">the</span>
<span class="pre">spacing</span>&#160;&#160;&#160; <span class="pre">between</span> <span class="pre">the</span>&#160;&#160;&#160; <span class="pre">words</span> <span class="pre">of</span>&#160;&#160;&#160; <span class="pre">this</span> <span class="pre">sentence</span>&#160;&#160;&#160; <span class="pre">(words</span>
<span class="pre">should</span>&#160;&#160;&#160; <span class="pre">be</span> <span class="pre">grouped</span>&#160;&#160;&#160; <span class="pre">in</span> <span class="pre">pairs).</span></code></p>
<p>If the <code class="docutils literal notranslate"><span class="pre">--pep-references</span></code> option was supplied, there should be a live link to PEP 258 here.</p>
</section>
<section id="math">
<h2><a class="toc-backref" href="#id35"><span class="section-number">3.2. </span>Math</a><a class="headerlink" href="#math" title="Permalink to this headline">¶</a></h2>
<p>This is a test. Here is an equation:
<span class="math notranslate nohighlight">\(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\)</span>.
Here is another:</p>
<div class="math notranslate nohighlight" id="equation-this-is-a-label">
<span class="eqno">(1)<a class="headerlink" href="#equation-this-is-a-label" title="Permalink to this equation">¶</a></span>\[\nabla^2 f =
\frac{1}{r^2} \frac{\partial}{\partial r}
\left( r^2 \frac{\partial f}{\partial r} \right) +
\frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta}
\left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) +
\frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]</div>
<p>You can add a link to equations like the one above <a class="reference internal" href="#equation-this-is-a-label">(1)</a> by using <code class="docutils literal notranslate"><span class="pre">:eq:</span></code>.</p>
</section>
<section id="meta">
<h2><a class="toc-backref" href="#id36"><span class="section-number">3.3. </span>Meta</a><a class="headerlink" href="#meta" title="Permalink to this headline">¶</a></h2>
</section>
<section id="blocks">
<h2><a class="toc-backref" href="#id37"><span class="section-number">3.4. </span>Blocks</a><a class="headerlink" href="#blocks" title="Permalink to this headline">¶</a></h2>
<section id="literal-blocks">
<h3><a class="toc-backref" href="#id38"><span class="section-number">3.4.1. </span>Literal Blocks</a><a class="headerlink" href="#literal-blocks" title="Permalink to this headline">¶</a></h3>
<p>Literal blocks are indicated with a double-colon (“::”) at the end of
the preceding paragraph (over there <code class="docutils literal notranslate"><span class="pre">--&gt;</span></code>).  They can be indented:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span>if literal_block:
    text = &#39;is left as-is&#39;
    spaces_and_linebreaks = &#39;are preserved&#39;
    markup_processing = None
</pre></div>
</div>
<p>Or they can be quoted without indentation:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span>&gt;&gt; Great idea!
&gt;
&gt; Why didn&#39;t I think of that?
</pre></div>
</div>
</section>
<section id="line-blocks">
<h3><a class="toc-backref" href="#id39"><span class="section-number">3.4.2. </span>Line Blocks</a><a class="headerlink" href="#line-blocks" title="Permalink to this headline">¶</a></h3>
<div class="line-block">
<div class="line">This is a line block.  It ends with a blank line.</div>
<div class="line-block">
<div class="line">Each new line begins with a vertical bar (“|”).</div>
<div class="line">Line breaks and initial indents are preserved.</div>
</div>
<div class="line">Continuation lines are wrapped portions of long lines;
they begin with a space in place of the vertical bar.</div>
<div class="line-block">
<div class="line">The left edge of a continuation line need not be aligned with
the left edge of the text above it.</div>
</div>
</div>
<div class="line-block">
<div class="line">This is a second line block.</div>
<div class="line"><br /></div>
<div class="line">Blank lines are permitted internally, but they must begin with a “|”.</div>
</div>
<p>Take it away, Eric the Orchestra Leader!</p>
<blockquote>
<div><div class="line-block">
<div class="line">A one, two, a one two three four</div>
<div class="line"><br /></div>
<div class="line">Half a bee, philosophically,</div>
<div class="line-block">
<div class="line">must, <em>ipso facto</em>, half not be.</div>
</div>
<div class="line">But half the bee has got to be,</div>
<div class="line-block">
<div class="line"><em>vis a vis</em> its entity.  D’you see?</div>
<div class="line"><br /></div>
</div>
<div class="line">But can a bee be said to be</div>
<div class="line-block">
<div class="line">or not to be an entire bee,</div>
<div class="line-block">
<div class="line">when half the bee is not a bee,</div>
<div class="line-block">
<div class="line">due to some ancient injury?</div>
<div class="line"><br /></div>
</div>
</div>
</div>
<div class="line">Singing…</div>
</div>
</div></blockquote>
</section>
<section id="block-quotes">
<h3><a class="toc-backref" href="#id40"><span class="section-number">3.4.3. </span>Block Quotes</a><a class="headerlink" href="#block-quotes" title="Permalink to this headline">¶</a></h3>
<p>Block quotes consist of indented body elements:</p>
<blockquote>
<div><p>My theory by A. Elk.  Brackets Miss, brackets.  This theory goes
as follows and begins now.  All brontosauruses are thin at one
end, much much thicker in the middle and then thin again at the
far end.  That is my theory, it is mine, and belongs to me and I
own it, and what it is too.</p>
<p class="attribution">—Anne Elk (Miss)</p>
</div></blockquote>
</section>
<section id="doctest-blocks">
<h3><a class="toc-backref" href="#id41"><span class="section-number">3.4.4. </span>Doctest Blocks</a><a class="headerlink" href="#doctest-blocks" title="Permalink to this headline">¶</a></h3>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="s1">&#39;Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;&#39;</span>
<span class="go">Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="s1">&#39;(cut and pasted from interactive Python sessions)&#39;</span>
<span class="go">(cut and pasted from interactive Python sessions)</span>
</pre></div>
</div>
</section>
<section id="code-blocks">
<h3><a class="toc-backref" href="#id42"><span class="section-number">3.4.5. </span>Code Blocks</a><a class="headerlink" href="#code-blocks" title="Permalink to this headline">¶</a></h3>
<pre class="literal-block"># parsed-literal test
curl -O <a class="reference external" href="http://someurl/release">http://someurl/release</a>-v1.3.0.tar-gz</pre>
<div class="literal-block-wrapper docutils container" id="id23">
<div class="code-block-caption"><span class="caption-text">Code Blocks can have captions.</span><a class="headerlink" href="#id23" title="Permalink to this code">¶</a></div>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="nt">&quot;windows&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
<span class="w">    </span><span class="p">{</span><span class="w"></span>
<span class="w">    </span><span class="nt">&quot;panes&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
<span class="w">        </span><span class="p">{</span><span class="w"></span>
<span class="w">        </span><span class="nt">&quot;shell_command&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
<span class="w">            </span><span class="s2">&quot;echo &#39;did you know&#39;&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w">            </span><span class="s2">&quot;echo &#39;you can inline&#39;&quot;</span><span class="w"></span>
<span class="w">        </span><span class="p">]</span><span class="w"></span>
<span class="w">        </span><span class="p">},</span><span class="w"></span>
<span class="w">        </span><span class="p">{</span><span class="w"></span>
<span class="w">        </span><span class="nt">&quot;shell_command&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;echo &#39;single commands&#39;&quot;</span><span class="w"></span>
<span class="w">        </span><span class="p">},</span><span class="w"></span>
<span class="w">        </span><span class="s2">&quot;echo &#39;for panes&#39;&quot;</span><span class="w"></span>
<span class="w">    </span><span class="p">],</span><span class="w"></span>
<span class="w">    </span><span class="nt">&quot;window_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;long form&quot;</span><span class="w"></span>
<span class="w">    </span><span class="p">}</span><span class="w"></span>
<span class="p">],</span><span class="w"></span>
<span class="nt">&quot;session_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;shorthands&quot;</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</div>
<section id="emphasized-lines-with-line-numbers">
<h4><a class="toc-backref" href="#id43"><span class="section-number">3.4.5.1. </span>Emphasized lines with line numbers</a><a class="headerlink" href="#emphasized-lines-with-line-numbers" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="k">def</span> <span class="nf">some_function</span><span class="p">():</span>
<span class="linenos">2</span>    <span class="n">interesting</span> <span class="o">=</span> <span class="kc">False</span>
<span class="hll"><span class="linenos">3</span>    <span class="nb">print</span> <span class="s1">&#39;This line is highlighted.&#39;</span>
</span><span class="linenos">4</span>    <span class="nb">print</span> <span class="s1">&#39;This one is not...&#39;</span>
<span class="hll"><span class="linenos">5</span>    <span class="nb">print</span> <span class="s1">&#39;...but this one is.&#39;</span>
</span></pre></div>
</div>
</section>
</section>
</section>
<section id="sidebar">
<h2><a class="toc-backref" href="#id44"><span class="section-number">3.5. </span>Sidebar</a><a class="headerlink" href="#sidebar" title="Permalink to this headline">¶</a></h2>
<aside class="sidebar">
<p class="sidebar-title">Ch’ien / The Creative</p>
<img alt="../../../../_images/yi_jing_01_chien.jpg" src="../../../../_images/yi_jing_01_chien.jpg" />
<p><em>Above</em> CH’IEN THE CREATIVE, HEAVEN</p>
<p><em>Below</em> CH’IEN THE CREATIVE, HEAVEN</p>
</aside>
<p>The first hexagram is made up of six unbroken lines. These unbroken lines stand for the primal power,
which is light-giving, active, strong, and of the spirit. The hexagram is consistently strong in character,
and since it is without weakness, its essence is power or energy. Its image is heaven.
Its energy is represented as unrestricted by any fixed conditions in space and is therefore conceived of as motion.
Time is regarded as the basis of this motion.
Thus the hexagram includes also the power of time and the power of persisting in time, that is, duration.</p>
<p>The power represented by the hexagram is to be interpreted in a dual sense in terms of its action
on the universe and of its action on the world of men. In relation to the universe, the hexagram expresses the strong,
creative action of the Deity. In relation to the human world, it denotes the creative action of the holy man or sage,
of the ruler or leader of men, who through his power awakens and develops their higher nature.</p>
<section id="code-with-sidebar">
<h3><a class="toc-backref" href="#id45"><span class="section-number">3.5.1. </span>Code with Sidebar</a><a class="headerlink" href="#code-with-sidebar" title="Permalink to this headline">¶</a></h3>
<aside class="sidebar">
<p class="sidebar-title">A code example</p>
<p>With a sidebar on the right.</p>
</aside>
<div class="literal-block-wrapper docutils container" id="id24">
<div class="code-block-caption"><span class="caption-text">Literal includes can also have captions.</span><a class="headerlink" href="#id24" title="Permalink to this code">¶</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="linenos"> 2</span><span class="sd">&quot;&quot;&quot;Test Module for sphinx_rtd_theme.&quot;&quot;&quot;</span>
<span class="linenos"> 3</span>
<span class="linenos"> 4</span>
<span class="linenos"> 5</span><span class="k">class</span> <span class="nc">Foo</span><span class="p">:</span>
<span class="linenos"> 6</span>
<span class="linenos"> 7</span>    <span class="sd">&quot;&quot;&quot;Docstring for class Foo.</span>
<span class="linenos"> 8</span>
<span class="linenos"> 9</span><span class="sd">    This text tests for the formatting of docstrings generated from output</span>
<span class="linenos">10</span><span class="sd">    ``sphinx.ext.autodoc``. Which contain reST, but sphinx nests it in the</span>
<span class="linenos">11</span><span class="sd">    ``&lt;dl&gt;``, and ``&lt;dt&gt;`` tags. Also, ``&lt;tt&gt;`` is used for class, method names</span>
<span class="linenos">12</span><span class="sd">    and etc, but those will *always* have the ``.descname`` or</span>
<span class="linenos">13</span><span class="sd">    ``.descclassname`` class.</span>
<span class="linenos">14</span>
<span class="linenos">15</span><span class="sd">    Normal ``&lt;tt&gt;`` (like the &lt;tt&gt; I just wrote here) needs to be shown with</span>
<span class="linenos">16</span><span class="sd">    the same style as anything else with ````this type of markup````.</span>
<span class="linenos">17</span>
<span class="linenos">18</span><span class="sd">    It&#39;s common for programmers to give a code example inside of their</span>
<span class="linenos">19</span><span class="sd">    docstring::</span>
<span class="linenos">20</span>
<span class="linenos">21</span><span class="sd">        from test_py_module import Foo</span>
<span class="linenos">22</span>
<span class="linenos">23</span><span class="sd">        myclass = Foo()</span>
<span class="linenos">24</span><span class="sd">        myclass.dothismethod(&#39;with this argument&#39;)</span>
<span class="linenos">25</span><span class="sd">        myclass.flush()</span>
<span class="linenos">26</span>
<span class="linenos">27</span><span class="sd">        print(myclass)</span>
<span class="linenos">28</span>
<span class="linenos">29</span>
<span class="linenos">30</span><span class="sd">    Here is a link to :py:meth:`capitalize`.</span>
<span class="linenos">31</span><span class="sd">    Here is a link to :py:meth:`__init__`.</span>
<span class="linenos">32</span>
<span class="linenos">33</span><span class="sd">    &quot;&quot;&quot;</span>
<span class="linenos">34</span>
<span class="linenos">35</span>    <span class="c1">#: Doc comment for class attribute Foo.bar.</span>
<span class="linenos">36</span>    <span class="c1">#: It can have multiple lines.</span>
<span class="linenos">37</span>    <span class="n">bar</span> <span class="o">=</span> <span class="mi">1</span>
<span class="linenos">38</span>
<span class="linenos">39</span>    <span class="n">flox</span> <span class="o">=</span> <span class="mf">1.5</span>   <span class="c1">#: Doc comment for Foo.flox. One line only.</span>
<span class="linenos">40</span>
</pre></div>
</div>
</div>
</section>
</section>
<section id="references">
<h2><a class="toc-backref" href="#id46"><span class="section-number">3.6. </span>References</a><a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h2>
<section id="footnotes">
<h3><a class="toc-backref" href="#id47"><span class="section-number">3.6.1. </span>Footnotes</a><a class="headerlink" href="#footnotes" title="Permalink to this headline">¶</a></h3>
<dl class="footnote brackets">
<dt class="label" id="id6"><span class="brackets">1</span><span class="fn-backref">(<a href="#id1">1</a>,<a href="#id7">2</a>)</span></dt>
<dd><p>A footnote contains body elements, consistently indented by at
least 3 spaces.</p>
<p>This is the footnote’s second paragraph.</p>
</dd>
<dt class="label" id="label"><span class="brackets">2</span><span class="fn-backref">(<a href="#id3">1</a>,<a href="#id8">2</a>)</span></dt>
<dd><p>Footnotes may be numbered, either manually (as in <a class="footnote-reference brackets" href="#id6" id="id7">1</a>) or
automatically using a “#”-prefixed label.  This footnote has a
label so it can be referred to from multiple places, both as a
footnote reference (<a class="footnote-reference brackets" href="#label" id="id8">2</a>) and as a hyperlink reference
(<a class="reference internal" href="#label">label</a>).</p>
</dd>
<dt class="label" id="id9"><span class="brackets"><a class="fn-backref" href="#id2">3</a></span></dt>
<dd><p>This footnote is numbered automatically and anonymously using a
label of “#” only.</p>
</dd>
<dt class="label" id="id10"><span class="brackets"><a class="fn-backref" href="#id4">*</a></span></dt>
<dd><p>Footnotes may also use symbols, specified with a “*” label.
Here’s a reference to the next footnote: <a class="footnote-reference brackets" href="#id12" id="id11">†</a>.</p>
</dd>
<dt class="label" id="id12"><span class="brackets"><a class="fn-backref" href="#id11">†</a></span></dt>
<dd><p>This footnote shows the next symbol in the sequence.</p>
</dd>
<dt class="label" id="id13"><span class="brackets">4</span></dt>
<dd><p>Here’s an unreferenced footnote, with a reference to a
nonexistent footnote: <a href="#id63"><span class="problematic" id="id14">[5]_</span></a>.</p>
</dd>
</dl>
</section>
<section id="citations">
<h3><a class="toc-backref" href="#id48"><span class="section-number">3.6.2. </span>Citations</a><a class="headerlink" href="#citations" title="Permalink to this headline">¶</a></h3>
<dl class="footnote brackets">
<dt class="label" id="id15"><span class="brackets">11</span></dt>
<dd><p>This is the citation I made, let’s make this extremely long so that we can tell that it doesn’t follow the normal responsive table stuff.</p>
</dd>
<dt class="label" id="id16"><span class="brackets">12</span><span class="fn-backref">(<a href="#id5">1</a>,<a href="#id19">2</a>)</span></dt>
<dd><p>This citation has some <code class="docutils literal notranslate"><span class="pre">code</span> <span class="pre">blocks</span></code> in it, maybe some <strong>bold</strong> and
<em>italics</em> too. Heck, lets put a link to a meta citation <a class="footnote-reference brackets" href="#id18" id="id17">13</a> too.</p>
</dd>
<dt class="label" id="id18"><span class="brackets"><a class="fn-backref" href="#id17">13</a></span></dt>
<dd><p>This citation will have two backlinks.</p>
</dd>
</dl>
<p>Here’s a reference to the above, <a class="footnote-reference brackets" href="#id16" id="id19">12</a>, and a <span id="id20">[nonexistent]</span> citation.</p>
<p>Here is another type of citation: <cite>citation</cite></p>
</section>
<section id="glossary">
<h3><a class="toc-backref" href="#id49"><span class="section-number">3.6.3. </span>Glossary</a><a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h3>
<p>This is a glossary with definition terms for thing like <a class="reference internal" href="#term-Writing"><span class="xref std std-term">Writing</span></a>:</p>
<dl class="glossary simple">
<dt id="term-Documentation">Documentation<a class="headerlink" href="#term-Documentation" title="Permalink to this term">¶</a></dt><dd><p>Provides users with the knowledge they need to use something.</p>
</dd>
<dt id="term-Reading">Reading<a class="headerlink" href="#term-Reading" title="Permalink to this term">¶</a></dt><dd><p>The process of taking information into ones mind through the use of eyes.</p>
</dd>
<dt id="term-Writing">Writing<a class="headerlink" href="#term-Writing" title="Permalink to this term">¶</a></dt><dd><p>The process of putting thoughts into a medium for other people to <a class="reference internal" href="#term-Reading"><span class="xref std std-term">read</span></a>.</p>
</dd>
</dl>
</section>
<section id="targets">
<h3><a class="toc-backref" href="#id50"><span class="section-number">3.6.4. </span>Targets</a><a class="headerlink" href="#targets" title="Permalink to this headline">¶</a></h3>
<p id="example">This paragraph is pointed to by the explicit “example” target.
A reference can be found under <a class="reference internal" href="#inline-markup">Inline Markup</a>, above. <a class="reference internal" href="#inline-hyperlink-targets">Inline
hyperlink targets</a> are also possible.</p>
<p>Section headers are implicit targets, referred to by name. See
<a class="reference internal" href="#targets">Targets</a>, which is a subsection of <a href="#id64"><span class="problematic" id="id65">`Body Elements`_</span></a>.</p>
<p>Explicit external targets are interpolated into references such as “<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#id29" id="id31">5</a>”.</p>
<p>Targets may be indirect and anonymous.  Thus <a class="reference internal" href="#targets">this phrase</a> may also
refer to the <a class="reference internal" href="#targets">Targets</a> section.</p>
<p>Here’s a <a href="#id66"><span class="problematic" id="id67">`hyperlink reference without a target`_</span></a>, which generates an error.</p>
</section>
</section>
<section id="directives">
<h2><a class="toc-backref" href="#id51"><span class="section-number">3.7. </span>Directives</a><a class="headerlink" href="#directives" title="Permalink to this headline">¶</a></h2>
<section id="contents">
<h3><a class="toc-backref" href="#id52"><span class="section-number">3.7.1. </span>Contents</a><a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h3>
<p>These are just a sample of the many reStructuredText Directives. For others, please see:
<a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html">http://docutils.sourceforge.net/docs/ref/rst/directives.html</a>.</p>
</section>
<section id="centered-text">
<h3><a class="toc-backref" href="#id53"><span class="section-number">3.7.2. </span>Centered text</a><a class="headerlink" href="#centered-text" title="Permalink to this headline">¶</a></h3>
<p>You can create a statement with centered text with <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">centered::</span></code></p>
<p class="centered">
<strong>This is centered text!</strong></p></section>
<section id="images-figures">
<h3><a class="toc-backref" href="#id54"><span class="section-number">3.7.3. </span>Images &amp; Figures</a><a class="headerlink" href="#images-figures" title="Permalink to this headline">¶</a></h3>
<section id="images">
<h4><a class="toc-backref" href="#id55"><span class="section-number">3.7.3.1. </span>Images</a><a class="headerlink" href="#images" title="Permalink to this headline">¶</a></h4>
<p>An image directive (also clickable – a hyperlink reference):</p>
<a class="reference internal image-reference" href="#directives"><img alt="../../../../_images/yi_jing_01_chien.jpg" src="../../../../_images/yi_jing_01_chien.jpg" /></a>
</section>
<section id="figures">
<h4><a class="toc-backref" href="#id56"><span class="section-number">3.7.3.2. </span>Figures</a><a class="headerlink" href="#figures" title="Permalink to this headline">¶</a></h4>
<figure class="align-default" id="id25">
<img alt="reStructuredText, the markup syntax" src="../../../../_images/yi_jing_01_chien.jpg" />
<figcaption>
<p><span class="caption-text">A figure is an image with a caption and/or a legend:</span><a class="headerlink" href="#id25" title="Permalink to this image">¶</a></p>
<div class="legend">
<table class="docutils align-default">
<colgroup>
<col style="width: 20%" />
<col style="width: 80%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>re</p></td>
<td><p>Revised, revisited, based on ‘re’ module.</p></td>
</tr>
<tr class="row-even"><td><p>Structured</p></td>
<td><p>Structure-enhanced text, structuredtext.</p></td>
</tr>
<tr class="row-odd"><td><p>Text</p></td>
<td><p>Well it is, isn’t it?</p></td>
</tr>
</tbody>
</table>
<p>This paragraph is also part of the legend.</p>
</div>
</figcaption>
</figure>
<p>A figure directive with center alignment</p>
<figure class="align-center" id="id26">
<img alt="../../../../_images/yi_jing_01_chien.jpg" src="../../../../_images/yi_jing_01_chien.jpg" />
<figcaption>
<p><span class="caption-text">This caption should be centered.</span><a class="headerlink" href="#id26" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</section>
</section>
<section id="admonitions">
<h3><a class="toc-backref" href="#id57"><span class="section-number">3.7.4. </span>Admonitions</a><a class="headerlink" href="#admonitions" title="Permalink to this headline">¶</a></h3>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Directives at large.</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Don’t take any wooden nickels.</p>
</div>
<div class="admonition danger">
<p class="admonition-title">Danger</p>
<p>Mad scientist at work!</p>
</div>
<div class="admonition error">
<p class="admonition-title">Error</p>
<p>Does not compute.</p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>It’s bigger than a bread box.</p>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<ul class="simple">
<li><p>Wash behind your ears.</p></li>
<li><p>Clean up your room.</p>
<ul>
<li><p>Including the closet.</p></li>
<li><p>The bathroom too.</p>
<ul>
<li><p>Take the trash out of the bathroom.</p></li>
<li><p>Clean the sink.</p></li>
</ul>
</li>
</ul>
</li>
<li><p>Call your mother.</p></li>
<li><p>Back up your data.</p></li>
</ul>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is a note.
Equations within a note:
<span class="math notranslate nohighlight">\(G_{\mu\nu} = 8 \pi G (T_{\mu\nu}  + \rho_\Lambda g_{\mu\nu})\)</span>.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>15% if the service is good.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Example</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Thing1</p></td>
</tr>
<tr class="row-odd"><td><p>Thing2</p></td>
</tr>
<tr class="row-even"><td><p>Thing3</p></td>
</tr>
</tbody>
</table>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Strong prose may provoke extreme mental exertion.
Reader discretion is strongly advised.</p>
</div>
<div class="admonition-and-by-the-way admonition">
<p class="admonition-title">And, by the way…</p>
<p>You can make up your own admonition too.</p>
</div>
</section>
<section id="topics-sidebars-and-rubrics">
<h3><a class="toc-backref" href="#id58"><span class="section-number">3.7.5. </span>Topics, Sidebars, and Rubrics</a><a class="headerlink" href="#topics-sidebars-and-rubrics" title="Permalink to this headline">¶</a></h3>
<aside class="sidebar">
<p class="sidebar-title">Sidebar Title</p>
<p class="sidebar-subtitle">Optional Subtitle</p>
<p>This is a sidebar.  It is for text outside the flow of the main
text.</p>
<p class="rubric">This is a rubric inside a sidebar</p>
<p>Sidebars often appears beside the main text with a border and
background color.</p>
</aside>
<div class="topic">
<p class="topic-title">Topic Title</p>
<p>This is a topic.</p>
</div>
<p class="rubric">This is a rubric</p>
</section>
<section id="target-footnotes">
<h3><a class="toc-backref" href="#id59"><span class="section-number">3.7.6. </span>Target Footnotes</a><a class="headerlink" href="#target-footnotes" title="Permalink to this headline">¶</a></h3>
<dl class="footnote brackets">
<dt class="label" id="id29"><span class="brackets">5</span><span class="fn-backref">(<a href="#id30">1</a>,<a href="#id31">2</a>,<a href="#id32">3</a>)</span></dt>
<dd><p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p>
</dd>
</dl>
</section>
<section id="replacement-text">
<h3><a class="toc-backref" href="#id60"><span class="section-number">3.7.7. </span>Replacement Text</a><a class="headerlink" href="#replacement-text" title="Permalink to this headline">¶</a></h3>
<p>I recommend you try <a class="reference external" href="http://www.python.org/">Python, <em>the</em> best language around</a> <a class="footnote-reference brackets" href="#id29" id="id32">5</a>.</p>
</section>
<section id="compound-paragraph">
<h3><a class="toc-backref" href="#id61"><span class="section-number">3.7.8. </span>Compound Paragraph</a><a class="headerlink" href="#compound-paragraph" title="Permalink to this headline">¶</a></h3>
<div class="compound">
<p class="compound-first">This paragraph contains a literal block:</p>
<div class="compound-middle highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">Connecting</span><span class="p">...</span><span class="w"> </span><span class="n">OK</span><span class="w"></span>
<span class="n">Transmitting</span><span class="w"> </span><span class="n">data</span><span class="p">...</span><span class="w"> </span><span class="n">OK</span><span class="w"></span>
<span class="n">Disconnecting</span><span class="p">...</span><span class="w"> </span><span class="n">OK</span><span class="w"></span>
</pre></div>
</div>
<p class="compound-last">and thus consists of a simple paragraph, a literal block, and
another simple paragraph.  Nonetheless it is semantically <em>one</em>
paragraph.</p>
</div>
<p>This construct is called a <em>compound paragraph</em> and can be produced
with the “compound” directive.</p>
</section>
</section>
<section id="download-links">
<h2><a class="toc-backref" href="#id62"><span class="section-number">3.8. </span>Download Links</a><a class="headerlink" href="#download-links" title="Permalink to this headline">¶</a></h2>
<p><a class="reference download internal" download="" href="../../../../_downloads/26d49aeeb9c710e27197fda28b7c3516/yi_jing_01_chien.jpg"><code class="xref download docutils literal notranslate"><span class="pre">This</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">long</span> <span class="pre">download</span> <span class="pre">link</span> <span class="pre">should</span> <span class="pre">be</span> <span class="pre">blue,</span> <span class="pre">normal</span> <span class="pre">weight</span> <span class="pre">text</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">leading</span> <span class="pre">icon,</span> <span class="pre">and</span> <span class="pre">should</span> <span class="pre">wrap</span> <span class="pre">white-spaces</span></code></a></p>
</section>
</section>


             </article>

            </div>
            <footer>




    <hr>



  <div role="contentinfo">
    <p>
        &copy; Copyright 2022, NVIDIA Corporation.

    </p>
  </div>

      <div>
        Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
      </div>


</footer>

          </div>
        </div>

        <div class="pytorch-content-right" id="pytorch-content-right">
          <div class="pytorch-right-menu" id="pytorch-right-menu">
            <div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
              <ul>
<li><a class="reference internal" href="#">3. Paragraph Level Markup</a><ul>
<li><a class="reference internal" href="#inline-markup">3.1. Inline Markup</a></li>
<li><a class="reference internal" href="#math">3.2. Math</a></li>
<li><a class="reference internal" href="#meta">3.3. Meta</a></li>
<li><a class="reference internal" href="#blocks">3.4. Blocks</a><ul>
<li><a class="reference internal" href="#literal-blocks">3.4.1. Literal Blocks</a></li>
<li><a class="reference internal" href="#line-blocks">3.4.2. Line Blocks</a></li>
<li><a class="reference internal" href="#block-quotes">3.4.3. Block Quotes</a></li>
<li><a class="reference internal" href="#doctest-blocks">3.4.4. Doctest Blocks</a></li>
<li><a class="reference internal" href="#code-blocks">3.4.5. Code Blocks</a><ul>
<li><a class="reference internal" href="#emphasized-lines-with-line-numbers">3.4.5.1. Emphasized lines with line numbers</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#sidebar">3.5. Sidebar</a><ul>
<li><a class="reference internal" href="#code-with-sidebar">3.5.1. Code with Sidebar</a></li>
</ul>
</li>
<li><a class="reference internal" href="#references">3.6. References</a><ul>
<li><a class="reference internal" href="#footnotes">3.6.1. Footnotes</a></li>
<li><a class="reference internal" href="#citations">3.6.2. Citations</a></li>
<li><a class="reference internal" href="#glossary">3.6.3. Glossary</a></li>
<li><a class="reference internal" href="#targets">3.6.4. Targets</a></li>
</ul>
</li>
<li><a class="reference internal" href="#directives">3.7. Directives</a><ul>
<li><a class="reference internal" href="#contents">3.7.1. Contents</a></li>
<li><a class="reference internal" href="#centered-text">3.7.2. Centered text</a></li>
<li><a class="reference internal" href="#images-figures">3.7.3. Images &amp; Figures</a><ul>
<li><a class="reference internal" href="#images">3.7.3.1. Images</a></li>
<li><a class="reference internal" href="#figures">3.7.3.2. Figures</a></li>
</ul>
</li>
<li><a class="reference internal" href="#admonitions">3.7.4. Admonitions</a></li>
<li><a class="reference internal" href="#topics-sidebars-and-rubrics">3.7.5. Topics, Sidebars, and Rubrics</a></li>
<li><a class="reference internal" href="#target-footnotes">3.7.6. Target Footnotes</a></li>
<li><a class="reference internal" href="#replacement-text">3.7.7. Replacement Text</a></li>
<li><a class="reference internal" href="#compound-paragraph">3.7.8. Compound Paragraph</a></li>
</ul>
</li>
<li><a class="reference internal" href="#download-links">3.8. Download Links</a></li>
</ul>
</li>
</ul>

            </div>
          </div>
        </div>
      </section>
    </div>







       <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
         <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
         <script src="../../../../_static/jquery.js"></script>
         <script src="../../../../_static/underscore.js"></script>
         <script src="../../../../_static/doctools.js"></script>
         <script src="../../../../_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
         <script src="../../../../_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
         <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
         <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>




  <script type="text/javascript" src="../../../../_static/js/vendor/popper.min.js"></script>
  <script type="text/javascript" src="../../../../_static/js/vendor/bootstrap.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
  <script type="text/javascript" src="../../../../_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  <!-- Begin Footer -->

  <div class="container-fluid docs-tutorials-resources" id="docs-tutorials-resources">
    <div class="container">
      <div class="row">
        <div class="col-md-4 text-center">
          <h2>Docs</h2>
          <p>Access comprehensive developer documentation for PyTorch</p>
          <a class="with-right-arrow" href="https://pytorch.org/docs/stable/index.html">View Docs</a>
        </div>

        <div class="col-md-4 text-center">
          <h2>Tutorials</h2>
          <p>Get in-depth tutorials for beginners and advanced developers</p>
          <a class="with-right-arrow" href="https://pytorch.org/tutorials">View Tutorials</a>
        </div>

        <div class="col-md-4 text-center">
          <h2>Resources</h2>
          <p>Find development resources and get your questions answered</p>
          <a class="with-right-arrow" href="https://pytorch.org/resources">View Resources</a>
        </div>
      </div>
    </div>
  </div>

  <footer class="site-footer">
    <div class="container footer-container">
      <div class="footer-logo-wrapper">
        <a href="https://pytorch.org/" class="footer-logo"></a>
      </div>

      <div class="footer-links-wrapper">
        <div class="footer-links-col">
          <ul>
            <li class="list-title"><a href="https://pytorch.org/">PyTorch</a></li>
            <li><a href="https://pytorch.org/get-started">Get Started</a></li>
            <li><a href="https://pytorch.org/features">Features</a></li>
            <li><a href="https://pytorch.org/ecosystem">Ecosystem</a></li>
            <li><a href="https://pytorch.org/blog/">Blog</a></li>
            <li><a href="https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md">Contributing</a></li>
          </ul>
        </div>

        <div class="footer-links-col">
          <ul>
            <li class="list-title"><a href="https://pytorch.org/resources">Resources</a></li>
            <li><a href="https://pytorch.org/tutorials">Tutorials</a></li>
            <li><a href="https://pytorch.org/docs/stable/index.html">Docs</a></li>
            <li><a href="https://discuss.pytorch.org" target="_blank">Discuss</a></li>
            <li><a href="https://github.com/pytorch/pytorch/issues" target="_blank">Github Issues</a></li>
            <li><a href="https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf" target="_blank">Brand Guidelines</a></li>
          </ul>
        </div>

        <div class="footer-links-col">
          <ul>
            <li class="list-title">Stay up to date</li>
            <li><a href="https://www.facebook.com/pytorch" target="_blank">Facebook</a></li>
            <li><a href="https://twitter.com/pytorch" target="_blank">Twitter</a></li>
            <li><a href="https://www.youtube.com/pytorch" target="_blank">YouTube</a></li>
            <li><a href="https://www.linkedin.com/company/pytorch" target="_blank">LinkedIn</a></li>
          </ul>
          </div>

        <div class="footer-links-col">
          <ul>
            <li class="list-title">PyTorch Podcasts</li>
            <li><a href="https://open.spotify.com/show/6UzHKeiy368jKfQMKKvJY5" target="_blank">Spotify</a></li>
            <li><a href="https://podcasts.apple.com/us/podcast/pytorch-developer-podcast/id1566080008" target="_blank">Apple</a></li>
            <li><a href="https://www.google.com/podcasts?feed=aHR0cHM6Ly9mZWVkcy5zaW1wbGVjYXN0LmNvbS9PQjVGa0lsOA%3D%3D" target="_blank">Google</a></li>
            <li><a href="https://music.amazon.com/podcasts/7a4e6f0e-26c2-49e9-a478-41bd244197d0/PyTorch-Developer-Podcast?" target="_blank">Amazon</a></li>
          </ul>
         </div>
        </div>

        <div class="privacy-policy">
          <ul>
            <li class="privacy-policy-links"><a href="https://www.linuxfoundation.org/terms/" target="_blank">Terms</a></li>
            <li class="privacy-policy-links">|</li>
            <li class="privacy-policy-links"><a href="https://www.linuxfoundation.org/privacy-policy/" target="_blank">Privacy</a></li>
          </ul>
        </div>
        <div class="copyright">
        <p>© Copyright The Linux Foundation. The PyTorch Foundation is a project of The Linux Foundation.
          For web site terms of use, trademark policy and other policies applicable to The PyTorch Foundation please see
          <a href="www.linuxfoundation.org/policies/">www.linuxfoundation.org/policies/</a>. The PyTorch Foundation supports the PyTorch open source
          project, which has been established as PyTorch Project a Series of LF Projects, LLC. For policies applicable to the PyTorch Project a Series of LF Projects, LLC,
          please see <a href="www.lfprojects.org/policies/">www.lfprojects.org/policies/</a>.</p>
      </div>
     </div>

  </footer>

  <div class="cookie-banner-wrapper">
  <div class="container">
    <p class="gdpr-notice">To analyze traffic and optimize your experience, we serve cookies on this site. By clicking or navigating, you agree to allow our usage of cookies. As the current maintainers of this site, Facebook’s Cookies Policy applies. Learn more, including about available controls: <a href="https://www.facebook.com/policies/cookies/">Cookies Policy</a>.</p>
    <img class="close-button" src="../../../../_static/images/pytorch-x.svg">
  </div>
</div>

  <!-- End Footer -->

  <!-- Begin Mobile Menu -->

  <div class="mobile-main-menu">
    <div class="container-fluid">
      <div class="container">
        <div class="mobile-main-menu-header-container">
          <a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>
          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
        </div>
      </div>
    </div>

    <div class="mobile-main-menu-links-container">
      <div class="main-menu">
        <ul>
          <li>
            <a href="https://pytorch.org/get-started">Get Started</a>
          </li>

          <li>
            <a href="https://pytorch.org/ecosystem">Ecosystem</a>
          </li>

          <li>
            <a href="https://pytorch.org/mobile">Mobile</a>
          </li>

          <li>
            <a href="https://pytorch.org/blog/">Blog</a>
          </li>

          <li>
            <a href="https://pytorch.org/tutorials">Tutorials</a>
          </li>

          <li class="resources-mobile-menu-title">
            Docs
          </li>

          <ul class="resources-mobile-menu-items">
            <li>
              <a href="https://pytorch.org/docs/stable/index.html">PyTorch</a>
            </li>

            <li>
              <a href="https://pytorch.org/audio/stable/index.html">torchaudio</a>
            </li>

            <li>
              <a href="https://pytorch.org/text/stable/index.html">torchtext</a>
            </li>

            <li>
              <a href="https://pytorch.org/vision/stable/index.html">torchvision</a>
            </li>

            <li>
              <a href="https://pytorch.org/torcharrow">torcharrow</a>
            </li>

            <li>
              <a href="https://pytorch.org/data">TorchData</a>
            </li>

            <li>
              <a href="https://pytorch.org/torchrec">TorchRec</a>
            </li>

            <li>
              <a href="https://pytorch.org/serve/">TorchServe</a>
            </li>

            <li>
              <a href="https://pytorch.org/torchx/">TorchX</a>
            </li>

            <li>
              <a href="https://pytorch.org/xla">PyTorch on XLA Devices</a>
            </li>
          </ul>

          <li class="resources-mobile-menu-title">
            Resources
          </li>

           <ul class="resources-mobile-menu-items">

            <li>
              <a href="https://pytorch.org/features">About</a>
            </li>

            <li>
              <a href="https://pytorch.org/foundation">PyTorch Foundation</a>
            </li>

            <li>
              <a href="https://pytorch.org/#community-module">Community</a>
            </li>

            <li>
              <a href="https://pytorch.org/community-stories">Community Stories</a>
            </li>

            <li>
              <a href="https://pytorch.org/resources">Developer Resources</a>
            </li>

            <li>
              <a href="https://pytorch.org/events">Events</a>
            </li>

            <li>
              <a href="https://discuss.pytorch.org/">Forums</a>
            </li>

            <li>
              <a href="https://pytorch.org/hub">Models (Beta)</a>
            </li>
          </ul>

          <li>
            <a href="https://github.com/pytorch/pytorch">Github</a>
          </li>
        </ul>
      </div>
    </div>
  </div>

  <!-- End Mobile Menu -->

  <script type="text/javascript" src="../../../../_static/js/vendor/anchor.min.js"></script>

  <script type="text/javascript">
    $(document).ready(function() {
      mobileMenu.bind();
      mobileTOC.bind();
      pytorchAnchors.bind();
      sideMenus.bind();
      scrollToAnchor.bind();
      highlightNavigation.bind();
      mainMenuDropdown.bind();
      filterTags.bind();

      // Add class to links that have code blocks, since we cannot create links in code blocks
      $("article.pytorch-article a span.pre").each(function(e) {
        $(this).closest("a").addClass("has-code");
      });
    })
  </script>
</body>
</html>